home *** CD-ROM | disk | FTP | other *** search
/ Software USA 3 #10 / Software USA Volume 3.10.iso / pc / homeoff / docvu / run / integr.txt < prev    next >
Text File  |  1997-03-16  |  17KB  |  501 lines
  1. Specifications for DocView Integration with External Databases.
  2.  
  3.  
  4. -----------------------------------------------------------------------
  5. Informatik Inc. has available several utilities for special requirements,
  6. such as direct printing, scanning, batch conversions, image clipping, etc.  
  7. If you are looking for special functions that are not included in DocView, 
  8. please contact Informatik Inc.
  9. ------------------------------------------------------------------------
  10.  
  11. OVERVIEW
  12.  
  13. DocView supports many methods of viewing images:
  14.  
  15. 1.  Stand-alone viewing
  16.     Start-up DocView and open the images from the File menu.
  17.  
  18. 2.  From the File Manager, Explorer
  19.     Associate the image file extension with DocView, then double-click
  20.     on the file name and DocView will start up and display the image file.
  21.     Normally, a new instance of DocView is created each time you select a
  22.     file.  However, with the RUNDDE.EXE utility (see below) you can maintain 
  23.     a SINGLE INSTANCE.
  24.  
  25. 3.  From the Internet Browser
  26.     In the web browser, associate the image file extension with DocView, then 
  27.     click on the hyper-text file name on the web page (TIFF files) and DocView 
  28.     will start up and display the image file. Normally, a new instance of DocView 
  29.     is created each time you select a file.  However, with the RUNDDE.EXE utility 
  30.     (see below) you can maintain a SINGLE INSTANCE.
  31.  
  32. 4.  From another application
  33.     DocView can be integrated into virtually any application.  The preferred 
  34.     method is DDE Poke.  If DDE is not (easily) supported by the controlling
  35.     application, then the RUNDDE.EXE utility (see below) will handle the 
  36.     integration with a simple EXECUTE call.
  37.  
  38.     A single image file or a list of files can be 'passed' to DocView.  If a list 
  39.     of files is passed to DocView, the individual files can be browsed in DocView 
  40.     just like pages of a multi-page document.
  41.  
  42. -------------------------------------------------------------------------
  43.  
  44. QUICK DEMO
  45.  
  46. For a quick demo of a simple integration, type the following text in the Run box 
  47. of the Program Manager, File Manager (in Windows 95 click on Start and choose Run):
  48.  
  49. c:\docview\docview.exe c:\mydir\images\img0001.tif, My First Image
  50.  
  51. where:
  52.      c:\docview\docview.exe is the path to the DocView executable, 
  53.      c:\images\img0001.tif is the path to the image file, and
  54.      'My First Image' is the optional caption of the display window.
  55.  
  56.  
  57. Press OK and the image will be displayed in DocView.  If the third parameter is 
  58. omitted, DocView will show the image file name in the title bar (caption).
  59.  
  60. -------------------------------------------------------------------------
  61.  
  62. INTEGRATION
  63.  
  64. The following setup is required to integrate the external database with DocView:
  65.  
  66. The setup is done via the Setup menu.
  67.  
  68.  
  69.  
  70. The recommended interface is with DDE (Dynamic Data Interchange).  If your 
  71. database application does not support DDE (or if DDE does not seem to respond), 
  72. the interface can be accomplished with the RUNDDE.EXE utility.  For details 
  73. on the RUNDDE and SendKeys methods, please read the sections below.
  74.  
  75.  
  76. THE RUNDDE.EXE UTILITY 
  77. A QUICK METHOD TO CREATE THE INTEGRATION 
  78.  
  79. The quickest way to effectuate a working integration (one-way from your master 
  80. application to DocView) is as follows:
  81.  
  82. Make sure that the following files (among many other files) are in the DOCVIEW 
  83. directory:
  84.  
  85. -  DOCVIEW.EXE
  86. -  RUNDDE.EXE
  87. -  RUNDDE.INI 
  88.  
  89. Verify that the RUNDDE.INI file contains the following text:
  90.  
  91. [Setup]
  92. App=Docview
  93. EXEFile=c:\docview\docview.exe
  94. Timeout=100
  95.  
  96.  
  97. In your master application, 'attach' the following code to an event, e.g. a 
  98. button-click event:
  99.  
  100. param = "C:\MyDir\img001.tif"   '------ specify the image file name
  101. x = shell("C:\docview\rundde.exe " & param,3)  '----- space after the exe !!!'
  102.  
  103. Typically, the image file name will be extracted from a field in the master 
  104. application's window.  If so, your 'param' code above would be as follows:
  105.  
  106. param = [TheField]
  107.  
  108. where TheField would  be the name of the field that holds the image file name
  109. (with path).
  110.  
  111. With this method, you do not need to worry about DDE; the RUNDDE.EXE converts 
  112. the command to a DDE command that is compatible with DocView.  There may be some 
  113. (almost unnoticeable) response penalty for this convenience.
  114.  
  115.  
  116. --------------------------------------------------------------------
  117.  
  118.  
  119. THE PARAMETER STRING
  120.  
  121. The Parameter String is the specification you add to the EXECUTE command.  For 
  122. example, in the launch command 
  123.  
  124. X=Shell("C:\DOCVIEW\DOCVIEW.EXE C:\IMAGES\IMG0001.TIF
  125.  
  126. the C:\IMAGES\IMG0001.TIF is the parameter string. 
  127.  
  128.  
  129. Normally, the parameter string consists of the image file name that you want to 
  130. display.  The parameter can also include the title and the page number.  Furthermore, 
  131. the parameter can consist of several image files.  For more detail, read the sections 
  132. below.
  133.  
  134. Examples:
  135.  
  136. C:\IMAGES\IMG0001.TIF,Exhibit 
  137. C:\IMAGES\IMG0001.TIF page=15,Exhibit 15
  138.  
  139.  
  140. The parameter string can also be one of the following keywords not 
  141. case sensitive):
  142.  
  143. cmd-new
  144. cmd=close
  145. imagefile
  146. imagefile2
  147.  
  148. The 'cmd=new' command will open a new (empty) image window.  This function is useful 
  149. if you do not want the new image to replace the previous image.
  150.  
  151. The 'cmd=close' command will terminate DocView.
  152.  
  153. The imagefile and imagefile2 will allow you to send a batch of image files 
  154. to DocView.  Please read the section below.
  155.  
  156. For example, 
  157.  
  158. X=Shell("C:\DOCVIEW\DOCVIEW.EXE  cmd=close
  159.  
  160. will close DocView
  161.  
  162. -----------------------------------------------------------------------------
  163.  
  164. DDE (DYNAMIC DATA INTERCHANGE)
  165. A MORE ADVANCED DDE LINK 
  166.  
  167. You can write the DDE code directly into the master application.  This is the 
  168. most efficient and recommended method.  You need some knowledge of DDE coding, but
  169. you can use the examples given below as 'starter' templates.
  170.  
  171. The DDE elements are as follows:
  172.  
  173.    Application = Docview
  174.    Topic = Linkform
  175.    Item  = Linkbox 
  176.  
  177.  
  178. If you have any questions, please contact Informatik Inc.  The email address 
  179. and telephone number are shown at the bottom of this text file.
  180.  
  181.  
  182.    EXAMPLE OF A CODE IN THE MS ACCESS APPLICATION:
  183.    -----------------------------------------------
  184.    Sub TheButton_Click()  'executed when the user clicks on the TheButton.
  185.        Dim Chan   
  186.        Dim x 
  187.        Dim param 
  188.  
  189.        On error resume next
  190.        param = [TheField]
  191.        Chan = DDEInitiate("Docview","Linkform")  ' Establish a DDE link
  192.        if err <> 0 then    ' if DocView is not yet running  .....
  193.            x = shell("C:\docview\docview.exe " & param,3)   'start up Docview. (Space after 'exe'!)
  194.        else
  195.            DDEPoke Chan, "Linkbox", param   'Poke the data to DocView
  196.            DDETerminateAll   'Close the DDE link
  197.        endif
  198.    End Sub
  199.  
  200.    (Where param represents the parameter sent to DocView.) 
  201.  
  202.  
  203.    EXAMPLE OF A CODE IN AN VISUAL BASIC APPLICATION 
  204.    ------------------------------------------------
  205.    Sub Command1_Click ()
  206.        On Error Resume Next
  207.        ddelink.LinkMode = 0
  208.        ddelink.LinkTopic = "Docview|Linkform"
  209.        ddelink.LinkItem = "Linkbox"
  210.        ddelink.LinkMode = 2
  211.        If Err = 282 Then
  212.            dummy = Shell("c:\docview\install\docview.exe ddddddd", 1)           
  213.        else
  214.            ddelink.Caption = ddddddd
  215.            ddelink.LinkPoke
  216.            ddelink.LinkMode = 0
  217.        endif
  218.    End Sub
  219.  
  220.    (Where ddddddd represents the parameter sent to DocView.)
  221.  
  222.  
  223.    EXAMPLE OF PARADOX CODE
  224.    -----------------------
  225.    (partial coding)
  226.  
  227.    var
  228.        ddevar dde
  229.        filevar string
  230.    endvar
  231.  
  232.    filevar = "C:\mydir\img0001.tif"
  233.    ddevar.open("DocView", "Linkform", "Linkbox")
  234.    ddevar=filevar
  235.  
  236.  
  237.     EXAMPLE OF FOXPRO CODE
  238.     ----------------------
  239.  
  240.     (partial coding)
  241.  
  242.     img = "C:\xxx\img001.tif"
  243.     chan = ddeinitiate("DOCVIEW" , "Linkform")
  244.  
  245.          (Here, code must check for errors.  If the DDE chan could not 
  246.           be opened, the program should launch DocView, else it should 
  247.           proceed with the following function)
  248.  
  249.     x=DDEPoke(chan, "Linkbox", imagefile)
  250.  
  251.  
  252.  
  253.    (DocView, Linkform and Linkbox are keywords; use them as they are).
  254.  
  255.  
  256.  
  257. Please refer to the database application's user guide for the DDE syntax.
  258.  
  259. ----------------------------------------------------------------------------
  260.  
  261. MORE ABOUT THE PARAMETER STRING
  262.  
  263. As indicated above, in most cases the parameter consists simply of the file 
  264. name of the image that you want to display (with path and extension).  For 
  265. more advanced use, the parameter can be expanded.  
  266.  
  267.  
  268. The parameter is a single line string, such as
  269.  
  270.    ffffffff,ttttttttt
  271.  
  272.  
  273. where fffffff is the file name (with path and extension), and
  274.          ttttttt is the optional title (description) of the image.
  275.          
  276. The title, if used, will be displayed in the title bar of the image.
  277.  
  278. To open a specific page of a file, use the following syntax:
  279.    
  280. ffffffff page=n,tttttttt   (where n is the page number)
  281.  
  282. For a method of passing a batch of files, please read the section 
  283. on Multi-Page Functions below.
  284.  
  285.  
  286. ------------------------------------------------------------------------------
  287.  
  288.  
  289. BATCHES, MULTI-PAGE FUNCTIONS
  290.  
  291. DocView supports multi-page TIF and DCX files.  When a multi-page file is 
  292. opened, DocView reveals the page navigation buttons in the tool bar 
  293. (such as next, fast forward, last, etc.).
  294.  
  295. DocView can also emulate multi-page displays with single-page files.  
  296. If your imaging system uses separate files for each page of a document, 
  297. the file make-up of a document can be passed to DocView, and DocView can 
  298. display the files as if they were a multi-page file.  Essentially, in the 
  299. controlling application, you copy the file names to the Windows Clipboard 
  300. or save it as a IMGFILE.TXT file in DocView's directory (each file separated 
  301. by a comma or a hard return) and you fire the DDE command with the 
  302.  
  303.     'imagefile' keyword, if you use The Clipboard method, or 
  304.     'imagefile2' keyword, if you use the IMGFILE.TXT method.
  305.  
  306. For example, you would send a batch of files (listed in the IMGFILE.TXT file)
  307. to DocView as follows:
  308.  
  309. X=Shell("C:\DOCVIEW\DOCVIEW.EXE imagefile2
  310.  
  311. The IMGFILE.TXT might contain the following text:
  312.  
  313. c:\images\img0001.tif,c:\images\img0003.tif,c:\images\img0015.tif
  314.  
  315. -----------------------------------------------------------------------
  316.  
  317.  
  318. SYSTEM SETUP
  319.  
  320. If your interface is ONE-WAY, i.e. only from your database application to DocView 
  321. (no interface from DocView back to the database), then you can ignore the next 
  322. several paragraphs.
  323.  
  324. To create a link FROM DocView TO your database application, choose
  325. the Setup menu, click on Advanced button, and make the entries as explained 
  326. in the examples below:
  327.  
  328.  
  329. Example of a SETUP (for MSACCESS 2.0  DATABASE)
  330. --------------------------------------------------------
  331.  
  332. Database Editing Sub-System: 
  333. (only required for sending data FROM DocView TO the 
  334. master application)
  335.  
  336.     DDE Topic:
  337.         MSAccess|EditForm
  338.     DDE Item:
  339.         TheField
  340.     SendKeys String:
  341.         ====leave this line blank----
  342.  
  343.         Items 1-3 contain information about the external database's EDITING subsystem:
  344.              Item 1 is the DDE TOPIC (in the MS Access database system).
  345.              Item 2 is DDE ITEM (in the MS Access database system).
  346.              Item 3 (leave this line blank)
  347.  
  348.  
  349. Database Query Sub-System:
  350. (only required for sending data FROM DocView TO the 
  351. master application)
  352.  
  353.     DDE Topic:
  354.         MSAccess|QueryForm
  355.     DDE Item:
  356.         TheField
  357.     SendKeys String:
  358.         ====leave this line blank====
  359.  
  360.         Items 4-6 contain information about the external database's QUERY subsystem:
  361.              Item 4 is the DDE TOPIC (in the MS Access database system).  
  362.              Item 5 is DDE ITEM (in the MS Access database system). 
  363.              Item 6 (leave this line blank)
  364.  
  365.  
  366. ----------------------------------------------------------------------
  367.  
  368. DEFAULT SETTINGS
  369.  
  370. Various default settings can be specified in the Setup menu (or directly 
  371. in the DOCVIEW.INI file).
  372.  
  373. Optional Fixed Path:
  374.  
  375.     Example:   D:\DOCS
  376.  
  377.         specifies the fixed path name of the directory that holds the
  378.         image files. This is required only if the image address in the 
  379.         database does not include the directory name.
  380.  
  381. Path Substitution:
  382.  
  383.     Example:   D:
  384.  
  385.         specifies the path substitution.  An equal number of leading letters
  386.         of the path passed by the DDE parameter will be substituted.  To 
  387.         specify the number of characters to be replaced, add the number after 
  388.         a space, for example C:\AAA 9
  389.  
  390.  
  391. Master Window:
  392.  
  393.     Example:   0
  394.  
  395.         specifies the opening state of the parent (MDI) window:  
  396.         blank or 0 = normal, full screen size
  397.         1 = minimized
  398.         2 = maximized
  399.         3 = Fit-to-image, upper-left corner
  400.         x=nnnn y=nnnn will offset the window from the left and the top
  401.                    by the nnnn values, e.g x=1440 y = 720 will place 
  402.                    the window 1 inch from the left and 0.5 inches from the 
  403.                    top.  The window is sized to fit the image.
  404.  
  405.         x=right y=bottom will place the window at the absolute right and/or 
  406.                    bottom of the screen.   
  407.  
  408.  
  409. Image Windows Width:
  410.  
  411.     Example:   75
  412.  
  413.         specifies the width of the image display window.  If the value is 2, 
  414.         the window opens maximized, otherwise, if the value is 100 or less, 
  415.         the entry represents a percentage of the screen width.  If more than 100 
  416.         it represents the measurement in twips  (1440 twips = 1 inch; 576 twips = 1 cm).
  417.  
  418. Image Windows Height:
  419.  
  420.     Example:   95
  421.  
  422.         specifies the height of the image display window. If the value is 100 or less,
  423.         the entry represents a percentage of the available screen height, otherwise
  424.         it is measured in twips  (1440 twips = 1 inch; 576 twips = 1 cm).
  425.  
  426.  
  427. Magnification List
  428.  
  429.         Example:   25,50,100,150,200,300
  430.  
  431.         represents the list of magnification ratios that you want to see in the 
  432.         Magnification menu.
  433.  
  434.  
  435. Options:
  436.  
  437.         represents other options:
  438.         nosave = the Save As option in the image windows is suppressed.
  439.         nopaint = the Paint options are disabled.
  440.         noopen = the Open File options are disabled.
  441.         nosetup = the Setup option is disabled.  You need to 'undo' this flag 
  442.              by editing the INI file.
  443.         printall = the default is set to print ALL pages.
  444.         noprint  = disables the printing functions
  445.         fit = opens the image 'sized-to-fit'
  446.         scrolllock, scrolllockv, scrolllockh = locks the scroll position 
  447.               (both, vertical, horizontal).  When opening another image file,  
  448.               the system keeps the previous scroll position.  When changing 
  449.               pages, however, the scroll position is reset to base zero.
  450.  
  451.  
  452.       If you use several options, separate the options with a comma or a space.
  453.  
  454.  
  455. Print Offset:
  456.  
  457.       specifies the left and top margin for the purpose of printing (inches or 
  458.       centimeters depending on the Windows setup)
  459.  
  460.  
  461.  
  462. Sending data from DocView to the database application
  463. -----------------------------------------------------
  464.  
  465. When the user clicks on the Edit button (pencil) or the Query button (question 
  466. marks) in the toolbar of DocView, DocView pokes the file name of the currently 
  467. displayed image to the database application.  The information is sent to the 
  468. form and field specified in the setup (items 1,2 and 4,5, see SYSTEM SETUP above).
  469. In the database application, you need to write the appropriate code to handle 
  470. the poked data.
  471.  
  472. (VB Programmers please note:  The 'receiving' form must have the linkmode set 
  473. to 1  and the linktopic must agree with the topic specified in the setup.) 
  474.  
  475. --------------------------------------------------------------------------------
  476.  
  477.  
  478.  
  479.  
  480. ****************************************************************
  481. ****************************************************************
  482.  
  483. You can also interface DocView with the SendKeys method.  If you need 
  484. information on this method, please contact Informatik Inc. and ask for 
  485. the SENDKEYS.TXT file.  DDE is much superior to the SendKeys method, but 
  486. there may be situations where only the SendKeys method will work.
  487.  
  488. ****************************************************************
  489. ****************************************************************
  490.  
  491.  
  492. For support,  contact Informatik Inc. at 610.640.0339 
  493. or support@informatik.com.
  494.  
  495. Also, visit www.informatik.com/news.html for update
  496. announcements.
  497.  
  498.  
  499.  
  500.  
  501.